﻿// Copyright 2005, 2006 - Morten Nielsen (www.iter.dk)
//
// This file is part of SharpMap.
// SharpMap is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
// 
// SharpMap is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public License
// along with SharpMap; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 

using System;
using System.Runtime.Serialization;
using System.Collections.Generic;
using System.Text;


namespace Petra.Gis.ReferenceSystemServices
{
  /// <summary>
  /// Definition of linear unit, such as meter, mile,....
  /// </summary>
  [DataContract]
  public partial class DistanceUnit : MeasureUnit
  {

    /// <summary>
    /// xaml constructor
    /// </summary>
    public DistanceUnit() { }



    
    
    /// <summary>
    /// Creates an instance of a linear unit
    /// </summary>
    /// <param name="metersPerUnit">Number of meters per <see cref="LinearUnit" /></param>
    /// <param name="metadata">Object metadata</param>
    public DistanceUnit(double metersPerUnit, Metadata metadata)
      :base(metadata)
    {
      MetersPerUnit = metersPerUnit;
      //MeasureUnit.AllUnits.Add(this);
    }




    #region DistanceUnit Members


    //protected double _MetersPerUnit;

    /// <summary>
    /// Gets or sets the number of meters per <see cref="LinearUnit"/>.
    /// </summary>
    [DataMember(Name="METERSPERUNIT")]
    public double MetersPerUnit
    { get; set; }


    #endregion

    /// <summary>
    /// Checks whether the values of this instance is equal to the values of another instance.
    /// Only parameters used for coordinate system are used for comparison.
    /// Name, abbreviation, authority, alias and remarks are ignored in the comparison.
    /// </summary>
    /// <param name="obj"></param>
    /// <returns>True if equal</returns>
    public override bool EqualParams(object obj)
    {
      if (!(obj is DistanceUnit))
        return false;

      return (obj as DistanceUnit).MetersPerUnit == this.MetersPerUnit;
    }



  }
}